Issue#566 #630
Issue#566 #630
Conversation
Documented how playback speed mutation works and the effects with examples
|
super! two small things, you need to run |
|
@dvdsk , Ohh I forgot to run cargo fmt and yes your right . I should probably move the docs to the mod file, so it's more accessible. Expect the commit, any hour 24hrs from now . I was just so busy enjoying the weekend . 😅. |
ugochukwu-850
force-pushed
the
Issue#566
branch
from
04aaec1
to
2d24977
Compare
|
Alright , I think this is good @dvdsk , please review and merge. |
|
I found a great resource on documenting items, I have added it to the CONTRIBUTING.md guidlines: https://github.com/RustAudio/rodio/blob/master/CONTRIBUTING.md#documentation |
|
@dvdsk nice vets , I would take an extra look on the contribution guidelines you cited and by tomorrow , I should have this in optimum status . Btw I wanted to propose a new feature on the output stream structure , could I create a new issue for that . |
yes please do |
|
@dvdsk Thanks for the resources you added to the contribution guidelines ; they were very useful . I think we are good now , please review and merge if its ok. |
src/source/mod.rs
Outdated
| @@ -412,6 +412,7 @@ where | |||
| } | |||
|
|
|||
| /// Changes the play speed of the sound. Does not adjust the samples, only the play speed. | |||
| /// Creates a Speed struct that handles the speed control | |||
There was a problem hiding this comment.
Could you replace this with the documentation from the Sink? I especially would like the note that the pitch will change. Finally could you note how the pitch will change (so at 0.5 speed is it higher or lower). That is something that might not be clear for readers of the doc.
There was a problem hiding this comment.
@dvdsk I have made the required changes , I also added some part of the doc to the sink.set_speed function to increase accessibility . Please review and merge
I added docs on the effects of changing the speed on both total_duration and pitch on both the source.speed trait and sink set_speed functions . This should help users understand what each function does
I added docs on the effects of changing the speed on both total_duration and pitch on both the source.speed trait and sink set_speed functions . This should help users understand what each function does
|
thank you very much! |
In this PR,
I have made changes in the speed.rs module . Explaining how the entire module works
I have also added a note on the set speed function - Specifying there would be an increase of pitch
I have also removed the note comment from @dvdsk on the try_seek method : As the reason for the commit is now fixed